Skip to main content

ARCursor

A cursor that represents a player's mouse in the 3D world. For use with AR devices.

Camera

The camera of the player associated with the mouse. It is of the type ARCamera. It is read-only, it cannot be assigned to.

Hit

The CFrame the user's mouse is located at. It is of the type CFrame. It is read-only, it cannot be assigned to.

MouseDelta

The current change in position of the mouse for the frame that was sent. It is of the type Vector2. It is read-only, it cannot be assigned to.

Origin

A CFrame indicating where the mouse originated from. It is positioned at the camera and oriented toward the mouse's 3D position. It is of the type Vector3. It is read-only, it cannot be assigned to.

Player

The name of the player the cursor is for. It is of the type string. It is read-only, it cannot be assigned to.

Pressed

A boolean for whether or not the mouse button is pressed. It is of the type boolean. It is read-only, it cannot be assigned to.

ScreenPosition

The XY screen position of the mouse cursor. It is of the type Vector2. It is read-only, it cannot be assigned to.

Target

The PartObject that is being hovered over. You can call methods on this part! It is of the type PilotObject. It is read-only, it cannot be assigned to.

UnitRay

A Ray directed toward the mouse's position in 3D space. It originates from the CFrame of the camera. Like all unit rays, it has a magnitude of 1. It is of the type Ray. It is read-only, it cannot be assigned to.

UserCFrames

Contains Head, LeftHand, and RightHand CFrames for VR.

It is of the type CFrame. It is read-only, it cannot be assigned to.

LeftHand

It is of the type CFrame. It is read-only, it cannot be assigned to.

RightHand

It is of the type CFrame. It is read-only, it cannot be assigned to.

It is read-only, it cannot be assigned to.

UserId

The user ID of the player. It is of the type number. It is read-only, it cannot be assigned to.

UserInput

A table of input data (would suggest printing with repr) - Contains Mouse, Keyboard, Gamepad, VREnabled, KeyboardEnabled, TouchEnabled, GamepadEnabled, and LastInputType. It is of the type ARInput. It is read-only, it cannot be assigned to.

VirtualTarget

The hovered part in the virtual 3D space. It is of the type BasePart. It is read-only, it cannot be assigned to.

VirtualWorldPosition

The world position of the mouse cursor in the virtual 3D space. It is of the type Vector3. It is read-only, it cannot be assigned to.

WorldPosition

The world position of the mouse cursor. It is of the type Vector3. It is read-only, it cannot be assigned to.

X

The X position of the cursor on the screen. It is of the type number. It is read-only, it cannot be assigned to.

Y

The Y position of the cursor on the screen. It is of the type number. It is read-only, it cannot be assigned to.

Luau Type

This is the luau type for ARCursor. It may help clear up mistranslations from the raw data to the wiki page (as it is an automatic process).

export type ARCursor = {
	read WorldPosition: Vector3,
	read Origin: Vector3,
	read UserId: number,
	read Target: PilotObject,
	read Pressed: boolean,
	read UnitRay: Ray,
	read Camera: ARCamera,
	read ScreenPosition: Vector2,
	read UserCFrames: {
		read RightHand: CFrame,
		read LeftHand: CFrame,
		read Head: CFrame,
	},
	read Y: number,
	read Player: string,
	read VirtualWorldPosition: Vector3,
	read Hit: CFrame,
	read X: number,
	read VirtualTarget: BasePart,
	read MouseDelta: Vector2,
	read UserInput: ARInput,
}